Skip to main content

Retrieve a Product

To get a warehouse product's details, there are two options.

  1. You can make a GET request to the /warehouse/v1/products/actions/get-id/{productCode} endpoint. This will return only the ID of the product which can then be used with the above GET request to get the entire data of the product. This is more lightweight and has better performance when only the ID is needed.
Example Request
GET /warehouse/v1/products/actions/get-id/{yourProductCode} HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Example Response
{
    "data": {
        "id": "6846ec3d2c6cde7965938157",
        "pickMode": "ASP"
    },
    "id": "b2a1c232-60e8-4716-badc-1f9cc7b74c3e",
    "resource": [],
    "errors": []
}

Once the ID is received, you can make a subsequent call to /warehouse/v1/products/{id} to return all of the details of the product

Example Request
GET /warehouse/v1/products/{your_id} HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Example Response
{
    "data": {
        "id": "6846ec3d2c6cde7965938157",
        "productCode": "test",
        "productDescription": "test",
        "productUnit": "UNT",
        "unitPrice": "0.0000",
        "unitPriceCurrency": "USD",
        "productAttributes": [],
        "customFields": [],
        "dimHeight": 13.250,
        "dimWidth": 10.000,
        "dimDepth": 5.000,
        "dimUnit": "IN",
        "weightPerProduct": 22.000,
        "weightPerProductUnit": "OZ",
        "clientProductCode": "123test",
        "clientProductDescription": "123test",
        "clientProductUnit": "UNT",
        "pickMode": "ASP"
    },
    "id": "9104dfb3-8dde-48fa-a502-a4c5e1f1facf",
    "resource": [],
    "errors": []
}
  1. You can make a GET request to the /warehouse/v1/products endpoint with the productCode as a query Parameter. EX: /warehouse/v1/products?productcode={productCode}. This will return the entire data of the product.
Example Request
GET /warehouse/v1/products?productcode={productCode} HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Example Response
{
    "data": {
        "products": [
            {
                "id": "6846ec3d2c6cde7965938157",
                "productCode": "test",
                "productDescription": "test",
                "productUnit": "UNT",
                "unitPrice": "0.0000",
                "unitPriceCurrency": "USD",
                "productAttributes": [],
                "customFields": [],
                "dimHeight": 13.250,
                "dimWidth": 10.000,
                "dimDepth": 5.000,
                "dimUnit": "IN",
                "weightPerProduct": 22.000,
                "weightPerProductUnit": "OZ",
                "clientProductCode": "123test",
                "clientProductDescription": "123test",
                "clientProductUnit": "UNT",
                "pickMode": "ASP"
            }
        ]
    },
    "id": "bd7974d0-500e-48ed-b1fe-fab9cc0a199f",
    "resource": [],
    "errors": []
}